home *** CD-ROM | disk | FTP | other *** search
/ Mac Magazin/MacEasy 62 / Mac Magazin and MacEasy Magazine CD - Issue 62.iso / Updates / SoundJam MP WhiteCap / whitecap.sea / WhiteCap 3.1.2 / WhiteCap Source.sit / WhiteCap Source / SJ SDK / VisFramework.h < prev    next >
Text File  |  1999-09-14  |  6KB  |  155 lines
  1.  
  2. //============================================================================
  3. //----------------------------------------------------------------------------
  4. //                                VisFramework.h
  5. //                                version 1.0.0
  6. //                                Mike Wright
  7. //                                darwin@mbay.net
  8. //
  9. //    Header file for the Visual Framework Plug-in module.
  10. //
  11. //----------------------------------------------------------------------------
  12. //============================================================================
  13.  
  14.  
  15. #pragma once
  16.  
  17.  
  18. #ifndef DEBUGLEVEL
  19. #define DEBUGLEVEL    DEBUGON
  20. #endif
  21.  
  22. #include "SoundJamAPI.h"
  23. #include "VisualPlugin.h"
  24.  
  25.  
  26. /*==================================================================================================
  27.                                     Defines
  28. ==================================================================================================*/
  29.  
  30.  
  31. /* visual framework plugin drawing modes */
  32. /*
  33. enum
  34. {    kLetterMode        = 1,
  35.     kLineMode        = 2,
  36.     kBoxMode        = 3,
  37.     kTwoColorMode    = 4,
  38.     kMultiColorMode    = 5
  39. };*/
  40.  
  41. /*==================================================================================================
  42.                                     Typedefs
  43. ==================================================================================================*/
  44.  
  45. /*======================================================================*/
  46. /* This is the struct that contains the global data that is stored in    */
  47. /* the refcon, restored in VisHandler(), and passed by VisHandler() to  */
  48. /* the handler  routines as *plugInData.                                */
  49. /*                                                                        */
  50. /* For purposes of the framework, fields have been included that match    */
  51. /* most fields of the various structs associated with the various         */
  52. /* messages. They are filled in by the handler routines for those         */
  53. /* messages.                                                            */
  54. /*                                                                        */
  55. /* You may remove any of these fields that your plugin does not use.    */
  56. /*                                                                        */
  57. /* There are also fields that are specific to the internal operation    */
  58. /* of the plugin module. These will change, depending on the needs of    */
  59. /* your plugin.                                                        */
  60. /*======================================================================*/
  61.  
  62. class WhiteCap;
  63.  
  64. struct VisHandlerData
  65. {
  66.     /* VisualPluginInitMessage data*/
  67.     void                *appCookie;
  68.     SoundJamProcPtr        playerProc;
  69.     UInt32                version;
  70.     
  71.     /* VisualPluginShowWindowMessage data */
  72.     CGrafPtr            port;
  73.     Rect                drawRect;
  74.     
  75.     /* VisualPluginPlayMessage data */
  76.     TrackSpec            *trackSpec;
  77.     SInt32                volume;
  78.     UInt32                bitRate;
  79.     SoundComponentData    soundFormat;
  80.     
  81.     /* VisualPluginRenderMessage data */
  82.     RenderVisualData    renderData;
  83.  
  84.     /* VisualPluginProcessSamplesMessage */
  85.     UInt32                timeStampID;
  86.     SInt16                *sampleBuffer;        /* the data in this buffer may be modified by the plugin    */
  87.     UInt32                numSamples;
  88.     UInt32                maxSamples;
  89.     UInt32                numOutputSamples;    /* must be less than or equal to maxSamples                 */
  90.     
  91.     /* framework-specific data */
  92.     OSType                magic;                /* used to identify our plugin for debugging purposes        */
  93.     bool                mPlayingMusic;
  94.     bool                mIsVisible;
  95. //    Boolean                visEnabled;            /* is it okay to draw to the module window?                    */
  96. //    UInt8                drawMode;            /* kLetterMode, kLineMode, and kBoxMode are possible values    */
  97. //    UInt8                colorMode;            /* kTwoColorMode and kMultiColorMode are possible values    */
  98. //    SInt16                LRcolor;            /* one of the eight basic QuickDraw color values            */
  99. //    SInt16                RLcolor;            /* one of the eight basic QuickDraw color values            */
  100.  
  101.     float                mSample[ NUM_SAMPLE_BINS ];
  102.     WhiteCap*            mWC;
  103. };
  104. typedef struct VisHandlerData VisHandlerData;
  105.  
  106.  
  107. /*======================================================================*/
  108. /* In our HandleCancelMessage() function, we set these fields to their    */
  109. /* equivalents in VisHandlerData. Then we use the PlayerSetPluginData()    */
  110. /* function to send this struct to SoundJam.                            */
  111. /* In our HandleInitializeMessage() function, we retrieve it from         */
  112. /* SoundJam using the PlayerSetPluginData() function.                    */
  113. /*                                                                         */
  114. /* You can modify this struct to save any preferences that you choose.    */
  115. /*======================================================================*/
  116. struct VisPluginPrefs
  117. {
  118.     UInt8                drawMode;            /* kLetterMode, kLineMode, and kBoxMode are possible values    */
  119.     UInt8                colorMode;            /* kTwoColorMode and kMultiColorMode are possible values    */
  120.     SInt16                LRcolor;            /* one of the eight basic QuickDraw color values            */
  121.     SInt16                RLcolor;            /* one of the eight basic QuickDraw color values            */    
  122. };
  123. typedef struct VisPluginPrefs     VisPluginPrefs; 
  124.  
  125. /*==================================================================================================
  126.                                     Function Prototypes
  127. ==================================================================================================*/
  128.  
  129. /* functions in VisFrameworkMain.c */
  130. OSStatus main (OSType message, PluginMessageInfo *messageInfo, void *refcon);
  131. OSStatus VisHandler (OSType message, VisualPluginMessageInfo *messageInfo, void *refcon);
  132.  
  133. /* functions in VisFrameworkHandlers.c */
  134. OSStatus HandleInitializeMessage (VisualPluginMessageInfo *messageInfo, VisHandlerData *plugInData);
  135. OSStatus HandleCleanupMessage (VisHandlerData *plugInData);
  136. OSStatus HandleEnableMessage (VisHandlerData *plugInData);
  137. OSStatus HandleDisableMessage (VisHandlerData *plugInData);
  138. OSStatus HandleShowWindowMessage (VisualPluginMessageInfo *messageInfo, VisHandlerData *plugInData);
  139. OSStatus HandleSetWindowMessage (VisualPluginMessageInfo *messageInfo, VisHandlerData *plugInData);
  140. OSStatus HandleHideWindowMessage (VisHandlerData *plugInData);
  141. OSStatus HandleResizeMessage (VisualPluginMessageInfo *messageInfo, VisHandlerData *plugInData);
  142. OSStatus HandlePlayMessage (VisualPluginMessageInfo *messageInfo, VisHandlerData *plugInData);
  143. OSStatus HandleStopMessage (VisHandlerData *plugInData);
  144. OSStatus HandlePauseMessage (VisHandlerData *plugInData);
  145. OSStatus HandleUnpauseMessage (VisHandlerData *plugInData);
  146. OSStatus HandleRenderMessage (VisualPluginMessageInfo *messageInfo, VisHandlerData *plugInData);
  147. OSStatus HandleProcessSamplesMessage (VisualPluginMessageInfo *messageInfo, VisHandlerData *plugInData);
  148. OSStatus HandleFlushSamplesMessage (VisHandlerData *plugInData);
  149. OSStatus HandleEventMessage (VisualPluginMessageInfo *messageInfo, VisHandlerData *plugInData);
  150. OSStatus HandleUpdateMessage (VisHandlerData *plugInData);
  151. OSStatus HandleIdleMessage (VisHandlerData *plugInData);
  152.  
  153.  
  154. void HandlePlugInMouseDown (VisHandlerData *plugInData, EventRecord *theEvent);
  155.